ValidatedIdentifier
A validated Identifier field.
There are various shortcut methods available for building ValidatedIdentifiers more easily than with the primary constructor. Check out options in the See Also section
Author
fzzyhmstrs
Since
0.1.2
Parameters
String, the string value of the default identifier
AllowableIdentifiers instance. Defines the predicate for valid ids, and the supplier of valid id lists
EntryValidator
See also
Samples
import me.fzzyhmstrs.fzzy_config.util.AllowableIdentifiers
import me.fzzyhmstrs.fzzy_config.util.EnumTranslatable
import me.fzzyhmstrs.fzzy_config.util.ValidationResult
import me.fzzyhmstrs.fzzy_config.validation.collection.ValidatedList
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIdentifier
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedRegistryType
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedTagKey
import me.fzzyhmstrs.fzzy_config.validation.misc.*
import me.fzzyhmstrs.fzzy_config.validation.misc.ValidatedColor.Companion.validatedColor
import me.fzzyhmstrs.fzzy_config.validation.number.ValidatedInt
import net.minecraft.item.Items
import net.minecraft.item.SwordItem
import net.minecraft.registry.Registries
import net.minecraft.registry.tag.ItemTags
import net.minecraft.util.Identifier
import java.awt.Color
import java.util.function.Function
fun main() {
//sampleStart
//Example validated identifier. Note that this "raw" usage of the constructor is not recommended in most cases.
//For instance, in this case, an implementation of ofRegistry(Registry, BiPredicate) would be advisable
val validatedIdentifier = ValidatedIdentifier(Identifier("oak_planks"), AllowableIdentifiers({ id -> id.toString().contains("planks") }, { Registries.BLOCK.ids.filter { it.toString().contains("planks") } }))
//Unbounded validated Identifier. Any valid Identifier will be allowed
val unboundedIdentifier = ValidatedIdentifier(Identifier("nether_star"))
//Unbounded validated Identifier directly from string. Any valid Identifier will be allowed
val stringIdentifier = ValidatedIdentifier("nether_star")
//Unbounded validated Identifier directly from string nbamespace and path. Any valid Identifier will be allowed
val stringStringIdentifier = ValidatedIdentifier("minecraft", "nether_star")
//Unbounded validated Identifier with a dummy default. used only for validation of other things
val emptyIdentifier = ValidatedIdentifier()
//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
"_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
"my_mod.my_config.subSection.fieldName": "Very Important Setting",
"my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
"""
//sampleEnd
}
Constructors
An unbounded validated identifier
An unbounded validated identifier constructed from a string
An unbounded validated identifier constructed from namespace and path strings
An unbounded validated identifier with a dummy default value
Functions
updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept
, validateAndSet
, setAndUpdate
and so on will all call the listener.
Creates a deep copy of the stored value and returns it
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.
Provides this validations default value
Whether this Translatable has a valid description
Whether this Translatable has a valid translation
creates a deep copy of this ValidatedIdentifier
Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue
Maps this validation to a new convertible type.
wraps the provided values into a ValidatedList with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
wraps the provided values into a ValidatedSet with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)
translation key of this Translatable. the "name" in-game
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.